home *** CD-ROM | disk | FTP | other *** search
/ Sprite 1984 - 1993 / Sprite 1984 - 1993.iso / man / cmds.fmt / man.man < prev    next >
Text File  |  1991-09-05  |  6KB  |  201 lines
  1.  
  2.  
  3.  
  4. MAN                       User Commands                       MAN
  5.  
  6.  
  7.  
  8. _________________________________________________________________
  9.  
  10. NNAAMMEE
  11.      man - Print entries in the user reference manual
  12.  
  13. SSYYNNOOPPSSIISS
  14.      mmaann [_o_p_t_i_o_n_s] [_s_e_c_t_i_o_n_N_u_m_b_e_r] _e_n_t_r_y_N_a_m_e _e_n_t_r_y_N_a_m_e ...
  15.  
  16. OOPPTTIIOONNSS
  17.      --aa             Search  all  man  directories.   By  default,
  18.                     directories  marked  "ALL"  in  the configure
  19.                     file will be skipped.  In Sprite, the --aa flag
  20.                     will  cause Software Warehouse directories to
  21.                     be searched.
  22.  
  23.      --cc _c_o_n_f_i_g_F_i_l_e  MMaann    normally    looks    in    the    file
  24.                     //sspprriittee//lliibb//mmaann//ccoonnffiigg  for information about
  25.                     where the man pages are.  If the --cc switch is
  26.                     given, then mmaann uses _c_o_n_f_i_g_F_i_l_e instead.
  27.  
  28.      --ii             Generate index.  Instead of  printing  manual
  29.                     entries, treat each _e_n_t_r_y_N_a_m_e as a file name.
  30.                     Read all the files, and output index informa-
  31.                     tion on standard output.
  32.  
  33.      --hheellpp          Print a summary of the  command-line  options
  34.                     and exit without printing any manual pages.
  35.  
  36.      --kk             Keyword search.  Instead of  printing  manual
  37.                     entries,  treat  each _e_n_t_r_y_N_a_m_e argument as a
  38.                     keyword, search the manual indexes for infor-
  39.                     mation  about the keywords, and print all the
  40.                     matching index entries.
  41.  
  42.      --rr             Normally, mmaann retains formatted  versions  of
  43.                     man  pages  for  faster  printing.   It  only
  44.                     reformats a man page if there is no formatted
  45.                     version  or  if  the source is newer than the
  46.                     formatted version.  This switch causes mmaann to
  47.                     reformat  the  man page even if the formatted
  48.                     copy appears to be up-to-date.
  49.  
  50.      --ss _s_e_c_t_i_o_n_N_a_m_e Check only  in  section  _s_e_c_t_i_o_n_N_a_m_e  of  the
  51.                     manual for the desired entries.
  52.  
  53.      --tt             Print  the  manual  entries  on  the  printer
  54.                     instead of on standard output.
  55.  
  56.      --              MMaann normally filters the  man  pages  through
  57.                     mmoorree  --ss  to  break up the output and process
  58.                     underline and boldface requests.   If  the  --
  59.                     switch  is  given,  then  the  mmoorree filter is
  60.  
  61.  
  62.  
  63. Sprite v.1.0       Printed:  September 5, 1991                  1
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. MAN                       User Commands                       MAN
  71.  
  72.  
  73.  
  74.                     omitted,  and  the  nnrrooffff  output  is  passed
  75.                     directly   to   standard  output.  The  PPAAGGEERR
  76.                     environment variable can be set to  the  name
  77.                     of a program to use instead of mmoorree.
  78.  
  79. _________________________________________________________________
  80.  
  81.  
  82. DDEESSCCRRIIPPTTIIOONN
  83.      The mmaann program locates and prints one or  more  entries  of
  84.      the  Sprite  reference manual.  The entries are given by the
  85.      _e_n_t_r_y_N_a_m_e arguments;  these are usually the  names  of  pro-
  86.      grams  or  library  procedures.   Normally, mmaann searches the
  87.      entire manual and invokes mmoorree to print the first entry that
  88.      matches  each  _e_n_t_r_y_N_a_m_e.   The  manual is divided into sec-
  89.      tions, and it is possible for the same name to be  used  for
  90.      entries in different sections.  You may use the --ss switch to
  91.      specify a particular section;  in this case, mmaann  will  look
  92.      only  in  the named section.  Section names include both the
  93.      traditional UNIX names (11, 22, etc.)  and  the  Sprite  names
  94.      (ccmmddss,  lliibb,  lliibb//cc,  ddeevv, etc.).  You may specify a section
  95.      name without the --ss switch if the section name starts with a
  96.      number and is entered as the first _e_n_t_r_y_N_a_m_e.
  97.  
  98.      The default configuration file causes the current  directory
  99.      to  be searched for the desired manual entry before the sys-
  100.      tem directories.  If there is a file  _e_n_t_r_y_N_a_m_e..mmaann  in  the
  101.      current  directory, then it will be printed in preference to
  102.      any entries in the system area.
  103.  
  104.      The --ii switch causes mmaann to generate  an  index  instead  of
  105.      printing a manual page.  Each _e_n_t_r_y_N_a_m_e argument is taken to
  106.      be a file name.  MMaann will read  all  the  files  and  output
  107.      index  information  for  them on standard output.  Normally,
  108.      each  directory  containing  installed  unformatted   manual
  109.      entries  also has a file named iinnddeexx containing index infor-
  110.      mation for all the files in the  directory.   When  printing
  111.      manual  entries,  if  mmaann  cannot  locate a file for a given
  112.      _e_n_t_r_y_N_a_m_e, then it reads the iinnddeexx files to see if _e_n_t_r_y_N_a_m_e
  113.      is  an alternate name for some other manual entry (an alter-
  114.      nate name is any name listed in  the  NNAAMMEE  section  of  the
  115.      entry).
  116.  
  117.      The --kk switch causes mmaann to perform a keyword search instead
  118.      of printing a manual page.  Each _e_n_t_r_y_N_a_m_e argument is taken
  119.      to be a keyword, and mmaann searches all the  iinnddeexx  files  for
  120.      entries  that  match  the  keywords.  Each matching entry is
  121.      printed on standard output in a human-readable form.  A key-
  122.      word  matches  an index entry if it is a substring of any of
  123.      the entry's name, synopsis, or keyword fields.
  124.  
  125.  
  126. FFIILLEESS
  127.      /sprite/lib/man/config - default configuration file
  128.  
  129.  
  130.  
  131. Sprite v.1.0       Printed:  September 5, 1991                  2
  132.  
  133.  
  134.  
  135.  
  136.  
  137.  
  138. MAN                       User Commands                       MAN
  139.  
  140.  
  141.  
  142. KKEEYYWWOORRDDSS
  143.      help, index, keyword, manual, reference, section
  144.  
  145.  
  146.  
  147.  
  148.  
  149.  
  150.  
  151.  
  152.  
  153.  
  154.  
  155.  
  156.  
  157.  
  158.  
  159.  
  160.  
  161.  
  162.  
  163.  
  164.  
  165.  
  166.  
  167.  
  168.  
  169.  
  170.  
  171.  
  172.  
  173.  
  174.  
  175.  
  176.  
  177.  
  178.  
  179.  
  180.  
  181.  
  182.  
  183.  
  184.  
  185.  
  186.  
  187.  
  188.  
  189.  
  190.  
  191.  
  192.  
  193.  
  194.  
  195.  
  196.  
  197. Sprite v.1.0       Printed:  September 5, 1991                  3
  198.  
  199.  
  200.  
  201.